Markup Burners

POST /MarkupBurner

Creates and starts a new MarkupBurner.

A MarkupBurner represents a process that runs on the server to "burn" markup into a document. The "burning" process makes the markup definitions a permanent part of a document. The server process is started by this request then a response is sent. Use the GET /MarkupBurner/{id} API below to get the status and results of an in-progress or completed MarkupBurner process.

The input required to create a MarkupBurner is two WorkFile objects; one representing the XML which defines the markup to burn, the other representing the source document on which to burn the markup. Refer to the Work Files API topic for more information.

A new document is created that contains the burned-in markup. The source document will not be modified. The new document will be made available by a new WorkFile ID.

By default, MarkupBurner objects will be automatically deleted 20 minutes after they are created.

Http Method

POST

Parameters

None

Request Body

In the request body, provide JSON containing the following properties:

Name	Description	Details
input.documentFileId	The ID of the WorkFile that represents the document to burn in the markup. This document will not be modified.	string, required Example: ek5Zb123oYHSUEVx1bUrVQ
input.markupFileId	The ID of the WorkFile that represents the XML document which contains the markup definition.	string, required Example: aQ1BdViqmUisBuevJKO9Sw
minSecondsAvailable	The minimum number of seconds which this MarkupBurner must remain available. If not provided, a configurable default value is used. This value is ignored if it is shorter than the configurable value.	integer, optional Example: 60

Response Body

If successful, this method returns JSON containing the following properties:

Name	Description	Details
input.documentFileId	The ID of the WorkFile that represents the document to burn in the markup. This document will not be modified. This is an echo of what was passed in by the request.	string Example: ek5Zb123oYHSUEVx1bUrVQ
input.markupFileId	The ID of the WorkFile that represents the XML document which contains the markup definition. This is an echo of what was passed in by the request.	string Example: aQ1BdViqmUisBuevJKO9Sw
expirationDateTime	The date and time (in ISO 8601 Extended Format) when the MarkupBurner will be deleted.	string Example: 60
processId	The ID of the MarkupBurner.	string Example: ElkNzWtrUJp4rXI5YnLUgw
state	The current state of the markup burning process running on the server. This will always be "processing" in this response.	string ("processing" \| "complete" \| "error" ) Example: "processing"
percentComplete	The percentage (0 – 100) complete of the markup burning process. This will always be 0 in this response.	integer Example: 0
errorCode	An error code string if a problem occurred during the markup burning process. This will always be null in this response.	string Example: null
output.documentFileId	The ID of the new WorkFile that represents a new document with markup burned into it. This will always be null in this response.	string

Status Codes

200 OK, if MarkupBurner was created successfully.
400 Bad Request, if input.documentFileId, input.markupFileId is missing or invalid format, if minSecondsAvailable is not a number.
405 Method Not Allowed, if POST HTTP method is not used.

Examples

Example Request	Copy Code
POST http://localhost:18681/PCCIS/V1/MarkupBurner Content-Type: application/json { "input": { "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ", "markupFileId": " aQ1BdViqmUisBuevJKO9Sw" }, "minSecondsAvailable": 60 }

Example Request

Copy Code

POST http://localhost:18681/PCCIS/V1/MarkupBurner
Content-Type: application/json
{
    "input": {
        "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ",
        "markupFileId": " aQ1BdViqmUisBuevJKO9Sw"
    },
    "minSecondsAvailable": 60
}

Example Response	Copy Code
200 OK Content-Type: application/json { "input": { "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ ", "markupFileId": " aQ1BdViqmUisBuevJKO9Sw " }, "expirationDateTime": "2014-12-17T20:38:39.796Z", "processId": "ElkNzWtrUJp4rXI5YnLUgw", "state": "processing", "percentComplete": 0, "errorCode": null, "output": null }

Example Response

Copy Code

200 OK
Content-Type: application/json
{
    "input": {
        "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ ",
        "markupFileId": " aQ1BdViqmUisBuevJKO9Sw "
    },
    "expirationDateTime": "2014-12-17T20:38:39.796Z",
    "processId": "ElkNzWtrUJp4rXI5YnLUgw",
    "state": "processing",
    "percentComplete": 0,
    "errorCode": null,
    "output": null

}

GET /MarkupBurner/{MarkupBurnerId}

Gets the status and result of an existing MarkupBurner.

Requests can be sent to this URL repeatedly while state is "processing".

When state is "complete", the new document with burned-in annotations will be made available by a new WorkFile ID in the output.documentFileId. Refer to the Work Files API topic to find out how to download a WorkFile.

If the markup burning process encountered an error, the state property will be "error", the errorCode property will contain an error code string and output will be null.

Http Method

GET

Parameters

Name

Description

Details

MarkupBurnerId

The ID of the MarkupBurner.

string, required

Example: ElkNzWtrUJp4rXI5YnLUgw

Request Body

None

Response Body

If successful, this method returns JSON containing the following properties:

Name	Description	Details
input.documentFileId	The ID of the WorkFile that represents the document to burn in the markup. This document will not be modified.	string Example: ek5Zb123oYHSUEVx1bUrVQ
input.markupFileId	The ID of the WorkFile that represents the XML document which contains the markup definition.	string Example: aQ1BdViqmUisBuevJKO9Sw
expirationDateTime	The date and time (in ISO 8601 Extended Format) when the MarkupBurner will be deleted.	string Example: 60
processId	The ID of the MarkupBurner.	string Example: ElkNzWtrUJp4rXI5YnLUgw
state	The current state of the markup burning process running on the server.	string ("processing" \| "complete" \| "error" ) Example: "complete"
percentComplete	The percentage (0 – 100) complete of the markup burning process. Note: The percent complete will only ever be 0 or 100.	integer Example: 100
errorCode	An error code string if a problem occurred during the markup burning process.	string Example: "DocumentFileIdDoesNotExist"
output.documentFileId	The ID of the new WorkFile that represents a new document with markup burned into it.	string Example: vry3FPE0zQqYwhzndRccOQ

Status Codes

200 OK, if MarkupBurner was retrieved successfully.
404 Not Found, if MarkupBurnerId does not exist.
405 Method Not Allowed, if GET HTTP method is not used.

Examples

Example Request	Copy Code
GET http://localhost:18681/PCCIS/V1/MarkupBurner/ElkNzWtrUJp4rXI5YnLUgw

Example Response	Copy Code
200 OK Content-Type: application/json { "input": { "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ ", "markupFileId": " aQ1BdViqmUisBuevJKO9Sw " }, "expirationDateTime": "2014-12-17T20:38:39.796Z", "processId": "ElkNzWtrUJp4rXI5YnLUgw", "state": "complete", "percentComplete": 100, "errorCode": null, "output": { "documentFileId": " vry3FPE0zQqYwhzndRccOQ" }, }

Example Response

Copy Code

200 OK
Content-Type: application/json
{
    "input": {
        "documentFileId": " ek5Zb123oYHSUEVx1bUrVQ ",
        "markupFileId": " aQ1BdViqmUisBuevJKO9Sw "
    },
    "expirationDateTime": "2014-12-17T20:38:39.796Z",
    "processId": "ElkNzWtrUJp4rXI5YnLUgw",
    "state": "complete",
    "percentComplete": 100,
    "errorCode": null,
    "output": {
        "documentFileId": " vry3FPE0zQqYwhzndRccOQ"
    },
}